home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 24 / AACD 24.iso / AACD / Online / Epic4 / share / epic / help / 6_functions / eof < prev    next >
Text File  |  2001-03-21  |  600b  |  22 lines
  1. Synopsis:
  2.    $eof(<file descriptor>)
  3.  
  4. Technical:
  5.    This function tests whether the client is currently at the end of the
  6.    file pointed to by the given file descriptor.  The only valid input is
  7.    a file descriptor returned by the $open() function.
  8.  
  9. Practical:
  10.    This function is used to see if the end of a file has been reached.
  11.    This is mostly useful while reading a file, such that it can be closed
  12.    once the end is reached.
  13.  
  14. Returns:
  15.    -1   error, no such file descriptor
  16.     0   not at end of file
  17.     1   end of file reached
  18.  
  19. See also:
  20.    close(6); open(6); read(6)
  21.  
  22.